FOR DISCUSSION: Mods to make nyc work properly for bedrock modules. #8
Conversation
test/package.json
Outdated
| @@ -3,7 +3,10 @@ | |||
| "version": "0.0.1-0", | |||
| "private": true, | |||
| "scripts": { | |||
| "test": "node --preserve-symlinks test.js test" | |||
| "test": "NODE_PATH=./node_modules node --preserve-symlinks test.js test", | |||
There was a problem hiding this comment.
Use NODE_PATH env var to tell node to use the node_modules folder in the test folder.
At first, this may seem terrible. However, it may solve an separate issue we've been having. This needs to be tested. That issue is that...
In order to get our linting stuff working for devs, we have to do an npm install on the root of the module, which installs all of the dependencies. This is partially due to the fact that doing npm install --only dev does not work with eslint. See: digitalbazaar/eslint-config-digitalbazaar#33
So, having dependencies in the node_modules in the root of the project can lead to confusion when devs need to symlink other deps for testing in the test framework. For instance, if a dev creates a symlink for test/node_modules/edv-client, node_modules/edv-client will still be used instead.
test/test.js
Outdated
| @@ -12,7 +12,8 @@ require('bedrock-kms-http'); | |||
| require('bedrock-passport'); | |||
| require('bedrock-permission'); | |||
| require('bedrock-profile'); | |||
| require('bedrock-profile-http'); | |||
| // require('bedrock-profile-http'); | |||
| require('..'); | |||
There was a problem hiding this comment.
The worst part is this. Although we could continue adding the module to the test package file with the file:.. syntax, we would require it using a relative require.
I'm going to spend a bit more time attempting to see if nyc can be bent to our will here. But I'm not hopeful due to the nyc issue referenced in the PR description.
mattcollier
force-pushed
the
working_coverage
branch
from
0fc1072
to
ac63a54
Compare
mattcollier
force-pushed
the
working_coverage
branch
from
0fe5168
to
74ca4e7
Compare
The good news is, we have A way of getting coverage on a Bedrock module.
Here's a report: https://codecov.io/gh/digitalbazaar/bedrock-profile-http/tree/e3f64b57bec39764f23303461b0860c2798bef7b/lib
The bad news is that nyc doesn't like working with stuff in node_modules generally and detests symlinks all-together.
See this: istanbuljs/nyc#1301 (comment)
I will highlight the specific changes in files.